<HTML>
<HEAD>
<TITLE>HELP - Special Sections</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - Special Sections</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','Documenting0',this)" class="pathLink">Documenting</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">Special Sections</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("divID707","aID707","LeftMenuActive","leftMenuLinkActive");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_page','SpecialSections0','_description',this)" class="tabLinkActive">Description</a></span>
<script type="text/javascript">
 Body4();
</script>
&nbsp;<br>
<div class="padding"><div class="userParagraph1"> Special sections (Notes, Todo, etc.)</div>
Special section are used to document return values, author notes etc. Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.<br>
<br>
</div>
<div class="padding"><div class="userParagraph3">Multiple use of these makes a bulleted list</div>
<table cellspacing=0 cellpadding=0 border=0 class="userTableBorder">
<tr>
<td class="userPaddingNormal1">&nbsp;<b>Syntax</b> </td><td class="userPaddingNormal1">&nbsp;<b>Reference manual </b> </td><td class="userPaddingNormal2">&nbsp;<b>Example</b> </td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\bug ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/bugCmd0',this)">bugCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Bug2587069908',this)">HowToDocument::Bug</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\deprecated ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/deprecatedCmd0',this)">deprecatedCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Deprecated2587069908',this)">HowToDocument::Deprecated</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\throw &lt;exception_name&gt; ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/throwCmd0',this)">throwCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/ExceptionsThrown2587069908',this)">HowToDocument::ExceptionsThrown</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\internal ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/internalCmd0',this)">internalCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Internal2587069908',this)">HowToDocument::Internal</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\note ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/noteCmd0',this)">noteCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Note2587069908',this)">HowToDocument::Note</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\param ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/paramCmd0',this)">paramCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/ParametersJavaStyle4173613626',this)">HowToDocument::ParametersJavaStyle</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\remark ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/remarkCmd0',this)">remarkCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Remark2587069908',this)">HowToDocument::Remark</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\sa ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/saCmd0',this)">saCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/SeeAlso2587069908',this)">HowToDocument::SeeAlso</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\todo ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/todoCmd0',this)">todoCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Todo2587069908',this)">HowToDocument::Todo</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\warning ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/warningCmd0',this)">warningCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Warning2587069908',this)">HowToDocument::Warning</a></td></tr>
</table>
<br>
</div>
<div class="padding"><div class="userParagraph3"> Only intended to be used once per entity (multiples are concatenated)</div>
<table cellspacing=0 cellpadding=0 border=0 class="userTableBorder">
<tr>
<td class="userPaddingNormal1">&nbsp;<b>Syntax</b> </td><td class="userPaddingNormal1">&nbsp;<b>Reference manual </b> </td><td class="userPaddingNormal2">&nbsp;<b>Example</b> </td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\author ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/authorCmd0',this)">authorCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Author2587069908',this)">HowToDocument::Author</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\brief ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/briefCmd0',this)">briefCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/BriefCmd2587069908',this)">HowToDocument::BriefCmd</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\return ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/returnCmd0',this)">returnCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/ReturnValue2095680291',this)">HowToDocument::ReturnValue</a><br>
</td></tr>
<tr>
<td class="userPaddingHeadMultiColumn1">&nbsp;<code>\version ... text ...</code> </td><td class="userPaddingNormal1">&nbsp;<a href="#" OnMouseOver="link('_page','../Command_Reference/versionCmd0',this)">versionCmd</a> </td><td class="userPaddingNormal2">&nbsp;<a href="#" OnMouseOver="link('_member','../Example_Code/Version2587069908',this)">HowToDocument::Version</a></td></tr>
</table>
</div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_page','_description');
</script>
